[Java] Add BeforeAll and AfterAll hooks #1876

mpkorstanje · 2020-01-26T16:32:47Z

Summary

BeforeAll and AfterAll hooks are executed before all scenarios are executed and
after all scenarios have been executed. A hook is declared by annotating a method.
This methods must be static and do not take any arguments.

Hooks are global, all hooks declared in any step definition class will be
executed. The order in which hooks are executed is not defined. An explicit
order can be provided by using the order property in the annotation.

package io.cucumber.example;

import io.cucumber.java.AfterAll;
import io.cucumber.java.BeforeAll;

public class StepDefinitions {

    @BeforeAll
    public static void beforeAll() {
        // Runs before all scenarios
    }

    @AfterAll
    public static void afterAll() {
        // Runs after all scenarios
    }
}

Notes:

When used in combination with Junit 5, Maven Surefire, and/or Failsafe use
version 3.0.0-M5 or later.
When used in combination with Junit 5 and InteliJ IDEA failures in before
all and after all hooks do not fail a test run.

Fixes: #515.

Types of changes

Bug fix (non-breaking change which fixes an issue).
New feature (non-breaking change which adds functionality).
Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist:

I've added tests for my code.
My change requires a change to the documentation.
I have updated the documentation accordingly.

Work in progress to fix #515. TODO: - [ ] How to deal with failure? - [ ] Test with JUnit4 - [ ] Test with JUnit5 - [ ] Test with TestNG - [ ] Test with CLI - [ ] Invoke around semantics? - [ ] How to report execution results? - [ ] TeamCity Plugin - [ ] Pretty formatter - [ ] Messages/Events

coveralls · 2020-01-26T16:40:55Z

Coverage decreased (-0.3%) to 87.604% when pulling 2f4e9da on before-all-and-after-all-hooks into 218dcae on master.

mpkorstanje · 2020-02-19T23:33:46Z

To avoid conflicting with JUnit annotations it might be a good idea use names that are relatively unique. For example BeforeEachScenario and BeforeAllScenarios. This will ensure people don't import the wrong annnotation by accident.

Naumansh · 2020-03-22T21:30:28Z

Is there any tentative timeline on it and will it work equally good with parallel executions as well?

mpkorstanje · 2020-03-22T22:19:44Z

This is an opensource project so there are no promises, timetables or guarantees. It will be done when it is done.

It will work as expected with parallel execution within one instance of Cucumber. Because a static context is used for the before hooks different runners (e.g. from the temyers/cucumber-jvm-parallel-plugin) will interfere with each other when executed concurrently.

So effectively it will be the same as using JUnits 4 @Before/AfterClass annotated methods or JUnit 5s @Before/AfterAll annotated methods. Note that the cucumber-junit will play nicely with both JUnit 4 class rules and the @Before/AfterClass annotations.

Naumansh · 2020-03-30T17:33:50Z

@mpkorstanje Just confirming . So the crux is it won't work in forked mode or multi jvm?

mpkorstanje · 2020-04-01T23:56:32Z

No. As I said, it will work as expected with parallel execution within one instance of Cucumber. For other situations you're dependent on the implementation of your hooks.

…all-hooks

codecov · 2021-02-28T11:04:19Z

Codecov Report

Merging #1876 (67889c2) into v7.x.x (018c315) will increase coverage by 0.08%.
The diff coverage is 88.64%.

@@             Coverage Diff              @@
##             v7.x.x    #1876      +/-   ##
============================================
+ Coverage     83.27%   83.35%   +0.08%     
- Complexity     2313     2340      +27     
============================================
  Files           298      299       +1     
  Lines          8256     8374     +118     
  Branches        750      762      +12     
============================================
+ Hits           6875     6980     +105     
- Misses         1084     1096      +12     
- Partials        297      298       +1

Impacted Files	Coverage Δ	Complexity Δ
core/src/main/java/io/cucumber/core/cli/Main.java	`0.00% <ø> (ø)`	`0.00 <0.00> (ø)`
...in/java/io/cucumber/core/plugin/JsonFormatter.java	`73.72% <0.00%> (ø)`	`51.00 <0.00> (ø)`
...ava/io/cucumber/core/plugin/ProgressFormatter.java	`77.14% <ø> (+3.45%)`	`4.00 <0.00> (ø)`
.../src/main/java/io/cucumber/core/runner/Runner.java	`91.58% <56.25%> (-6.22%)`	`33.00 <4.00> (+4.00)`	⬇️
...main/java/io/cucumber/java/JavaHookDefinition.java	`90.00% <66.66%> (-2.60%)`	`10.00 <0.00> (+1.00)`	⬇️
.../src/main/java/io/cucumber/java/MethodScanner.java	`82.35% <80.00%> (+1.10%)`	`35.00 <4.00> (+1.00)`
...ucumber/core/runtime/CucumberExecutionContext.java	`90.90% <83.33%> (-1.52%)`	`16.00 <2.00> (+4.00)`	⬇️
...ava/io/cucumber/java/JavaStaticHookDefinition.java	`85.00% <85.00%> (ø)`	`6.00 <6.00> (?)`
...rc/main/java/io/cucumber/core/runtime/Runtime.java	`92.45% <90.00%> (-0.69%)`	`13.00 <2.00> (+1.00)`	⬇️
...ber/core/exception/CompositeCucumberException.java	`100.00% <100.00%> (ø)`	`1.00 <1.00> (-3.00)`
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 018c315...67889c2. Read the comment docs.

…all-hooks

…r-all-hooks

anaega · 2022-06-08T15:38:00Z

Hello! I am trying to use @BeforeAll but it doesn't work for me..nothing happens, it seems that this method is never used.

import io.cucumber.java.Before;
import io.cucumber.java.BeforeAll;

public class BeforeSteps {

    @BeforeAll
    public static void beforeAll() {
        log.info("Log BeforeAlL");
    }
}

<properties>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <serenity.version>3.2.3</serenity.version>
       <cucumber.version>7.2.3</cucumber.version>
       <lombok.version>1.18.22</lombok.version>
       <slf4j.version>1.7.36</slf4j.version>
       <logback.version>1.2.10</logback.version>
       <rest.assured.version>4.5.0</rest.assured.version>
       <postgres.version>42.2.5</postgres.version>
   </properties>
   <dependencies>
       <dependency>
           <groupId>net.serenity-bdd</groupId>
           <artifactId>serenity-core</artifactId>
           <version>${serenity.version}</version>
           <scope>test</scope>
           <exclusions>
               <exclusion>
                   <groupId>io.cucumber</groupId>
                   <artifactId>cucumber-core</artifactId>
               </exclusion>
           </exclusions>
       </dependency>
       <dependency>
           <groupId>io.cucumber</groupId>
           <artifactId>cucumber-java</artifactId>
           <version>${cucumber.version}</version>
       </dependency>
       <dependency>
           <groupId>io.cucumber</groupId>
           <artifactId>cucumber-junit</artifactId>
           <version>${cucumber.version}</version>
       </dependency>
       <dependency>
           <groupId>net.serenity-bdd</groupId>
           <artifactId>serenity-junit</artifactId>
           <version>${serenity.version}</version>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>net.serenity-bdd</groupId>
           <artifactId>serenity-cucumber</artifactId>
           <version>${serenity.version}</version>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>junit</groupId>
           <artifactId>junit</artifactId>
           <version>4.13.2</version>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>org.assertj</groupId>
           <artifactId>assertj-core</artifactId>
           <version>3.22.0</version>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>org.hamcrest</groupId>
           <artifactId>hamcrest-all</artifactId>
           <version>1.3</version>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>com.google.code.gson</groupId>
           <artifactId>gson</artifactId>
           <version>2.9.0</version>
           <scope>compile</scope>
       </dependency>
       <dependency>
           <groupId>org.apache.kafka</groupId>
           <artifactId>kafka-clients</artifactId>
           <version>2.8.0</version>
       </dependency>
       <dependency>
           <groupId>com.google.guava</groupId>
           <artifactId>guava</artifactId>
           <version>31.1-jre</version>
           <scope>compile</scope>
       </dependency>
       <dependency>
           <groupId>commons-io</groupId>
           <artifactId>commons-io</artifactId>
           <version>2.11.0</version>
       </dependency>
       <dependency>
           <groupId>net.htmlparser.jericho</groupId>
           <artifactId>jericho-html</artifactId>
           <version>3.4</version>
           <scope>test</scope>
       </dependency>
   </dependencies>
   <build>
       <plugins>
           <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-surefire-plugin</artifactId>
               <version>3.0.0-M5</version>
               <configuration>
                   <skip>true</skip>
               </configuration>
           </plugin>
           <plugin>
               <artifactId>maven-failsafe-plugin</artifactId>
               <version>3.0.0-M5</version>
               <configuration>
                   <includes>
                       <include>**/*Test.java</include>
                       <include>**/Test*.java</include>
                       <include>**/*TestSuite.java</include>
                       <include>**/When*.java</include>
                   </includes>

               </configuration>
               <executions>
                   <execution>
                       <goals>
                           <goal>integration-test</goal>
                           <goal>verify</goal>
                       </goals>
                   </execution>
               </executions>
           </plugin>
           <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-compiler-plugin</artifactId>
               <version>3.8.0</version>
               <configuration>
                   <source>1.8</source>
                   <target>1.8</target>
               </configuration>
           </plugin>

DO you have any ideea what I can do?
Thank you!

mpkorstanje · 2022-06-09T23:26:43Z

To report a bug you'll want to start a new issue. Commenting on old ones just hides the discussion from view.

If you do report a bug make sure you have a minimal reproducer. So remove all the parts that are not essential to reproducing the problem. You can read more about that here:

https://stackoverflow.com/help/how-to-ask

Also if you do report a bug, make sure you have the right open source project. You are using Serenity, not Cucumber. 😉

mpkorstanje added this to the 5.x.x milestone Jan 26, 2020

bernatv approved these changes Jan 30, 2020

View reviewed changes

mpkorstanje mentioned this pull request Mar 22, 2020

A question: Is there anyway to get the count of executed scenarios and in queue scenarios at runitme ? #1922

Closed

Naumansh mentioned this pull request Mar 23, 2020

A Question: Maven Failsafe <threadCount> instead of <forkCount> for parallel run trivago/cucable-plugin#153

Closed

mpkorstanje modified the milestones: 5.x.x, v6.x.x Apr 17, 2020

mpkorstanje modified the milestones: v6.x.x, 7.0.0 Jun 23, 2020

mpkorstanje changed the base branch from master to main June 23, 2020 23:19

mpkorstanje force-pushed the main branch from c9d1c1c to 4d39dd6 Compare September 9, 2020 15:58

mpkorstanje force-pushed the main branch from b7a456b to c37e53e Compare September 26, 2020 20:32

Merge remote-tracking branch 'origin/main' into before-all-and-after-…

fa4907d

…all-hooks

mpkorstanje added this to In progress in JUnit5 via automation Mar 6, 2021

mpkorstanje mentioned this pull request Mar 8, 2021

Custom predicate #2258

Closed

mpkorstanje added 8 commits March 8, 2021 17:37

Merge remote-tracking branch 'origin/main' into before-all-and-after-…

ac7ed17

…all-hooks

Require void return type and invoke without object

c8d2a80

WIP Invoke around semantics

fbaeeac

JUnit Invoke around semantics

c64cc35

JUnit Invoke around semantics

950e158

TestNG Invoke around semantics

91002b4

Sort hooks

32b4d7b

Reduce diff size

b49a269

mpkorstanje added 13 commits March 26, 2021 17:42

Reduce logspam

a091372

Display before/after hook failure in teamcity plugin

6c852fc

Display before/after all failures in pretty formatter

314eeb7

Fix

3518c59

Fix

ce7967e

TODO: Extract error collector and move up

2781758

This works

4b047fb

Improve the examples

26b75ab

Merge remote-tracking branch 'origin/main' into before-all-and-after-…

3d18b44

…all-hooks

Fix tests

8f97461

Fix tests

c6f3768

Run after all hooks in reverse order

419aaa7

Run after all hooks in reverse order

01e9ca4

mpkorstanje force-pushed the before-all-and-after-all-hooks branch from b91f148 to 01e9ca4 Compare March 28, 2021 01:03

mpkorstanje added 3 commits April 2, 2021 23:50

Use suppressed exceptions for better readability

8eedf41

Update documentation

1b13fb3

Merge remote-tracking branch 'origin/main' into before-all-and-after-…

692870f

…all-hooks

mpkorstanje changed the base branch from main to v7.x.x April 2, 2021 22:17

Update docs

654a741

mpkorstanje marked this pull request as ready for review April 3, 2021 19:45

mpkorstanje added 3 commits April 3, 2021 22:01

Update tests

28f9d3c

Merge remote-tracking branch 'origin/v7.x.x' into before-all-and-afte…

5272080

…r-all-hooks

Update changelog

67889c2

mpkorstanje merged commit 3bc80b9 into v7.x.x Apr 3, 2021

JUnit5 automation moved this from In progress to Done Apr 3, 2021

mpkorstanje deleted the before-all-and-after-all-hooks branch April 3, 2021 21:28

mpkorstanje mentioned this pull request May 13, 2021

Option do define feature order without workaround #2297

Closed

flyingsilverfin mentioned this pull request Dec 17, 2021

Upgrade cucumber to access @BeforeAll and @AfterAll vaticle/typedb-driver#365

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Java] Add BeforeAll and AfterAll hooks #1876

[Java] Add BeforeAll and AfterAll hooks #1876

mpkorstanje commented Jan 26, 2020 •

edited

Loading

coveralls commented Jan 26, 2020

mpkorstanje commented Feb 19, 2020 •

edited

Loading

Naumansh commented Mar 22, 2020

mpkorstanje commented Mar 22, 2020 •

edited

Loading

Naumansh commented Mar 30, 2020

mpkorstanje commented Apr 1, 2020

codecov bot commented Feb 28, 2021 •

edited

Loading

anaega commented Jun 8, 2022 •

edited

Loading

mpkorstanje commented Jun 9, 2022

[Java] Add BeforeAll and AfterAll hooks #1876

[Java] Add BeforeAll and AfterAll hooks #1876

Conversation

mpkorstanje commented Jan 26, 2020 • edited Loading

Summary

Types of changes

Checklist:

coveralls commented Jan 26, 2020

mpkorstanje commented Feb 19, 2020 • edited Loading

Naumansh commented Mar 22, 2020

mpkorstanje commented Mar 22, 2020 • edited Loading

Naumansh commented Mar 30, 2020

mpkorstanje commented Apr 1, 2020

codecov bot commented Feb 28, 2021 • edited Loading

Codecov Report

anaega commented Jun 8, 2022 • edited Loading

mpkorstanje commented Jun 9, 2022

mpkorstanje commented Jan 26, 2020 •

edited

Loading

mpkorstanje commented Feb 19, 2020 •

edited

Loading

mpkorstanje commented Mar 22, 2020 •

edited

Loading

codecov bot commented Feb 28, 2021 •

edited

Loading

anaega commented Jun 8, 2022 •

edited

Loading